home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / fx / dmPMInitDirectory.z / dmPMInitDirectory
Encoding:
Text File  |  2002-10-03  |  7.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyy((((3333ddddmmmm))))                                  ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyy((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyy, ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyyWWWWiiiitttthhhhPPPPrrrrooooggggrrrreeeessssssss - initializes a
  10.      directory of plugins
  11.  
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ffffxxxx____pppplllluuuuggggiiiinnnn____mmmmggggrrrr....hhhh>>>>
  15.  
  16.      DDDDMMMMpppplllluuuuggggiiiinnnn******** ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyy
  17.            (((( DDDDMMMMpppplllluuuuggggmmmmggggrrrr**** mmmmaaaannnnaaaaggggeeeerrrr,,,,
  18.              ccccoooonnnnsssstttt cccchhhhaaaarrrr**** ppppaaaatttthhhhnnnnaaaammmmeeee,,,,
  19.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ttttyyyyppppeeeemmmmaaaasssskkkk ))))
  20.  
  21.      DDDDMMMMpppplllluuuuggggiiiinnnn******** ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyyWWWWiiiitttthhhhPPPPrrrrooooggggrrrreeeessssssss
  22.            (((( DDDDMMMMpppplllluuuuggggmmmmggggrrrr**** mmmmaaaannnnaaaaggggeeeerrrr,,,,
  23.              ccccoooonnnnsssstttt cccchhhhaaaarrrr**** ppppaaaatttthhhhnnnnaaaammmmeeee,,,,
  24.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ttttyyyyppppeeeemmmmaaaasssskkkk,,,,
  25.              DDDDMMMMpppprrrrooooggggrrrreeeessssssssccccaaaallllllllbbbbaaaacccckkkk ****pppprrrrooooggggrrrreeeessssssssCCCCaaaallllllllbbbbaaaacccckkkk,,,,
  26.              vvvvooooiiiidddd ****pppprrrrooooggggrrrreeeessssssssCCCClllliiiieeeennnnttttDDDDaaaattttaaaa ))))
  27.  
  28.  
  29. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  30.      _m_a_n_a_g_e_r              A pointer to a DDDDMMMMpppplllluuuuggggmmmmggggrrrr, which was returned from
  31.                           ddddmmmmPPPPMMMMCCCCrrrreeeeaaaatttteeeeMMMMaaaannnnaaaaggggeeeerrrr.
  32.  
  33.      _p_a_t_h_n_a_m_e             The pathname of the directory from which to
  34.                           initialize the plugins; can be NULL.
  35.  
  36.      _t_y_p_e_m_a_s_k             The typemask of the plugin type which is a bitwise
  37.                           combination of one or more of: DDDDMMMM____VVVVIIIIDDDDEEEEOOOO____FFFFIIIILLLLTTTTEEEERRRR,
  38.                           DDDDMMMM____VVVVIIIIDDDDEEEEOOOO____TTTTRRRRAAAANNNNSSSSIIIITTTTIIIIOOOONNNN, DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFIIIILLLLTTTTEEEERRRR, or
  39.                           DDDDMMMM____AAAALLLLLLLL____PPPPLLLLUUUUGGGGIIIINNNN____TTTTYYYYPPPPEEEESSSS.
  40.  
  41.      _p_r_o_g_r_e_s_s_C_a_l_l_b_a_c_k     The progressCallback is a pointer to a
  42.                           DDDDMMMMpppprrrrooooggggrrrreeeessssssssccccaaaallllllllbbbbaaaacccckkkk callback.  This callback gets
  43.                           triggered periodically during the loading of plugins
  44.                           if and only if, the plugin-manager cache file needs
  45.                           to be updated.  Define your callback like:
  46.  
  47.                           DMboolean myProgressCallback(
  48.                               float fractionComplete, /* 0.0 - 1.0 */
  49.                               void* clientData);
  50.  
  51.  
  52.      _p_r_o_g_r_e_s_s_C_l_i_e_n_t_D_a_t_a   The progressClientData gets passed into the
  53.                           progressCallback; can be NULL.
  54.  
  55.  
  56. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  57.      ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyy and ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyyWWWWiiiitttthhhhPPPPrrrrooooggggrrrreeeessssssss initialize a
  58.      directory of plugins. The plugin-manager manages a list of plugins and a
  59.      cached file that allows applications to use special effects plugins.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyy((((3333ddddmmmm))))                                  ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyy((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      Passing in NULL causes the plugin-manager to initialize the default
  75.      plugin directory.
  76.  
  77.  
  78. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  79.      ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyy and ddddmmmmPPPPMMMMIIIInnnniiiittttDDDDiiiirrrreeeeccccttttoooorrrryyyyWWWWiiiitttthhhhPPPPrrrrooooggggrrrreeeessssssss will return a pointer
  80.      to an array of DDDDMMMMpppplllluuuuggggiiiinnnn's if successful, or will return NULL if it fails.
  81.      The plug-in manager owns this array, therefore your application must not
  82.      free it.  You can access the plugins like:
  83.  
  84.  
  85.           DMplugin **plugins = dmPMInitDirectory(mgr, NULL, DM_VIDEO_FILTER);
  86.  
  87.           if (plugins)
  88.           {
  89.               int i;
  90.  
  91.               for (i = 0; i < dmPMGetPluginCount(mgr); i++)
  92.                    name = dmPMGetName(plugins[i]);
  93.           }
  94.  
  95.  
  96.  
  97. FFFFIIIILLLLEEEESSSS
  98.      ////uuuussssrrrr////lllliiiibbbb////ddddmmmmeeeeddddiiiiaaaa////pppplllluuuuggggiiiinnnnssss////pppprrrreeeemmmmiiiieeeerrrreeee     default plugin directory
  99.      $$$$HHHHOOOOMMMMEEEE////....ffffxxxxpppplllluuuuggggmmmmggggrrrr....ccccaaaacccchhhheeee               plugin-manager cache file
  100.  
  101. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  102.      dmPMCreateManager(3dm), dmPMGetPluginCount(3dm), dmPMInitPlugin(3dm),
  103.      dmPMFreePlugin(3dm), dmPMFreeAllPlugins(3dm), dmGetError(3dm).
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.